<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - GREUtils.CryptoHash</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/GREUtils.html">GREUtils</a></li>
	
	<li><a href="../symbols/GREUtils.Charset.html">GREUtils.Charset</a></li>
	
	<li><a href="../symbols/GREUtils.ControllerAdapter.html">GREUtils.ControllerAdapter</a></li>
	
	<li><a href="../symbols/GREUtils.CryptoHash.html">GREUtils.CryptoHash</a></li>
	
	<li><a href="../symbols/GREUtils.Dialog.html">GREUtils.Dialog</a></li>
	
	<li><a href="../symbols/GREUtils.Dir.html">GREUtils.Dir</a></li>
	
	<li><a href="../symbols/GREUtils.File.html">GREUtils.File</a></li>
	
	<li><a href="../symbols/GREUtils.JSON.html">GREUtils.JSON</a></li>
	
	<li><a href="../symbols/GREUtils.Pref.html">GREUtils.Pref</a></li>
	
	<li><a href="../symbols/GREUtils.Sound.html">GREUtils.Sound</a></li>
	
	<li><a href="../symbols/GREUtils.Thread.html">GREUtils.Thread</a></li>
	
	<li><a href="../symbols/GREUtils.Thread.CallbackRunnableAdapter.html">GREUtils.Thread.CallbackRunnableAdapter</a></li>
	
	<li><a href="../symbols/GREUtils.Thread.WorkerRunnableAdapter.html">GREUtils.Thread.WorkerRunnableAdapter</a></li>
	
	<li><a href="../symbols/GREUtils.XPCOM.html">GREUtils.XPCOM</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace GREUtils.CryptoHash
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				GREUtils.CryptoHash
A Javascript wrapper around the XPCOM nsiCryptoHash component that provides
native implementation of cryptographic hash function. This can be used,
for example, to calculate the MD5 hash of a file to determine if it contains
the data you think it does.

The hash algorithms supported are MD2, MD5, SHA-1, SHA-256, SHA-384, and SHA-512.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_home_rack_workspace_greutils_dist_GREUtils.js.html">GREUtils.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class GREUtils.CryptoHash.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/GREUtils.CryptoHash.html#constructor">GREUtils.CryptoHash</a></b>
							</div>
							<div class="description">A Javascript wrapper around the XPCOM nsiCryptoHash component that provides
native implementation of cryptographic hash function.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class GREUtils.CryptoHash.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.arrayToHexString">arrayToHexString</a></b>(data)
								</div>
								<div class="description">Returns the hexadecimal representation of an array of byte values.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.crypt">crypt</a></b>(str, algorithm)
								</div>
								<div class="description">Computes the hash of a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.cryptFromStream">cryptFromStream</a></b>(file, algorithm)
								</div>
								<div class="description">Computes the hash of a file.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.md5">md5</a></b>(str)
								</div>
								<div class="description">Computes the MD5 hash of a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.md5FromFile">md5FromFile</a></b>(aFile)
								</div>
								<div class="description">Computes the MD5 hash of a file.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.md5sum">md5sum</a></b>(aFile)
								</div>
								<div class="description">Computes the MD5 hash of a file.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.sha1">sha1</a></b>(str)
								</div>
								<div class="description">Computes the SHA-1 hash of a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.sha256">sha256</a></b>(str)
								</div>
								<div class="description">Computes the SHA-256 hash of a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">GREUtils.CryptoHash.<b><a href="../symbols/GREUtils.CryptoHash.html#.toHexString">toHexString</a></b>(charCode)
								</div>
								<div class="description">Returns the two-digit hexadecimal representation of a byte value.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>GREUtils.CryptoHash</b>
				</div>
				
				<div class="description">
					A Javascript wrapper around the XPCOM nsiCryptoHash component that provides
native implementation of cryptographic hash function. This can be used,
for example, to calculate the MD5 hash of a file to determine if it contains
the data you think it does.

The hash algorithms supported are MD2, MD5, SHA-1, SHA-256, SHA-384, and SHA-512.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".arrayToHexString"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>arrayToHexString</b>(data)
					
					</div>
					<div class="description">
						Returns the hexadecimal representation of an array of byte values.

This method takes an array of byte values and returns a string containing the
hexadecimal representation of each of the byte values in the array. Each byte
value will be represented as a two-digit hexadecimal value.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Array}</span> <b>data</b>
									
								</dt>
								<dd>This is the array of byte values</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The hexadecimal representation of the array of byte values</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".crypt"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>crypt</b>(str, algorithm)
					
					</div>
					<div class="description">
						Computes the hash of a string.

This method takes a UTF-8 string and computes its hash using the specified
algorithm.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>
									
								</dt>
								<dd>This is the UTF-8 string to compute the hash for</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>algorithm</b>
									
								</dt>
								<dd>This is the hash algorithm to use</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> string      The resulting hash as a hex string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".cryptFromStream"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>cryptFromStream</b>(file, algorithm)
					
					</div>
					<div class="description">
						Computes the hash of a file.

This method reads data from a file and computes its hash using the specified
algorithm. The file can be specified as a string containing the file path or
as an nsIFile object.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String|nsIFile}</span> <b>file</b>
									
								</dt>
								<dd>This is the file given as a file path or an nsIFile object</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>algorithm</b>
									
								</dt>
								<dd>This is the hash algorithm to use</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string; an empty string is returned if the file is empty or cannot be read</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".md5"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>md5</b>(str)
					
					</div>
					<div class="description">
						Computes the MD5 hash of a string.

This method takes a UTF-8 string and computes its hash using the MD5 algorithm.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>
									
								</dt>
								<dd>This is the UTF-8 string to compute the hash for</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".md5FromFile"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>md5FromFile</b>(aFile)
					
					</div>
					<div class="description">
						Computes the MD5 hash of a file.

This method reads data from a file and computes its hash using the MD5
algorithm. The file can be specified as a string containing the file path or
as an nsIFile object.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String|nsIFile}</span> <b>aFile</b>
									
								</dt>
								<dd>This is the file given as a file path or an nsIFile object</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string; an empty string is returned if the file is empty or cannot be read</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".md5sum"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>md5sum</b>(aFile)
					
					</div>
					<div class="description">
						Computes the MD5 hash of a file.

This method reads data from a file and computes its hash using the MD5
algorithm. The file can be specified as a string containing the file path or
as an nsIFile object.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String|nsIFile}</span> <b>aFile</b>
									
								</dt>
								<dd>This is the file given as a file path or an nsIFile object</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string; an empty string is returned if the file is empty or cannot be read</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".sha1"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>sha1</b>(str)
					
					</div>
					<div class="description">
						Computes the SHA-1 hash of a string.

This method takes a UTF-8 string and computes its hash using the SHA-1 algorithm.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>
									
								</dt>
								<dd>This is the UTF-8 string to compute the hash for</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".sha256"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>sha256</b>(str)
					
					</div>
					<div class="description">
						Computes the SHA-256 hash of a string.

This method takes a UTF-8 string and computes its hash using the SHA-256 algorithm.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>str</b>
									
								</dt>
								<dd>This is the UTF-8 string to compute the hash for</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The resulting hash as a hex string</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".toHexString"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{String}</span>
					<span class="light">GREUtils.CryptoHash.</span><b>toHexString</b>(charCode)
					
					</div>
					<div class="description">
						Returns the two-digit hexadecimal representation of a byte value.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>charCode</b>
									
								</dt>
								<dd>This is the byte value</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The two-digit hexadecimal representation of the byte value</dd>
							
							</dl>
						
						
						

					
				
			
			
			<hr />
		</div>
		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.1 on Thu Aug 28 2008 13:30:54 GMT+0800 (CST)
		</div>
	</body>
</html>
